/*
Copyright 2021 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package planner

import "context"

// NOTE: this is based on this prior work https://gianarb.it/blog/reactive-plan-golang-example
// which has been adapted for use here.

// Plan represents an interface for a plan of operations.
type Plan interface {
	// Create will perform the plan and will return a list of operations/procedures
	// that need to be run to accomplish the plan
	Create(ctx context.Context) ([]Procedure, error)
}

// Procedure represents a procedure/operation that will be carried out
// as part of executing a plan.
type Procedure interface {
	// Name is the name of the procedure/operation
	Name() string
	// Do will perform the operation/procedure
	Do(ctx context.Context) error
}
